Use nvidia-sphinx-theme for docs #528
Open
+22
−12
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
benfred
added
doc
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
|
/ok to test |
nvidia-sphinx-theme calls `sphinx.util.fileutil.copy_asset_file` with a Path - but sphinx v7.* expects a `str` , which causes the build to fail. Require sphinx v8 here to make this work
cjnolet
approved these changes
Dec 12, 2024
the docs build in CI is using an older version of breathe (v4.15.0) - which is from 2020 and doesn't support sphinx v8 (sphinx-doc/sphinx#11490). Fix by requiring the latest version
…into nvidia-sphinx-theme
jameslamb
approved these changes
Dec 12, 2024
There was a problem hiding this comment.
Seems fine to me, glad to see that it's on pypi.org: https://pypi.org/project/nvidia-sphinx-theme/#description
Breathe doesn't fully support sphinx v8 - it raises some warnings in sphinx since its passing a `str` to Sphinx functions that expect a `Path`. This still works for now (will be fully removed in sphinx v9), but is deprecated - which is why breathe indicates it only support sphinx<=v7.2 in conda. However, nvidia-sphinx-theme only works with sphinx v8 afaict, since it is passing a Path to `sphinx.util.fileutil.copy_asset_file` - which breaks on sphinx v7 since it's expecting a `str`. Hack around this dependency issue by installing breathe from pip, which isn't as strict about supported sphinx versions.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.